Node / meshtastic / Meshtastic-Android / files / androidApp / src / google / kotlin / org / meshtastic / app / ai / appfunctions / AppFunctionModels.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.app.ai.appfunctions

Tff7b72import T7ee787androidx.appfunctions.AppFunctionIntValueConstraint

Tff7b72import T7ee787androidx.appfunctions.AppFunctionSerializable

Tff7b72import T7ee787androidx.appfunctions.AppFunctionStringValueConstraint

T8b949e/** Response returned when a message is successfully sent via the mesh network. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364SendMessageResponseTb4b4b4(

T8b949e/** The identifier assigned to the outgoing message. */

Tff7b72val Te6edf3messageIdTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** The channel or destination the message was sent to. */

Tff7b72val Te6edf3channelTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** The time the message was sent (epoch milliseconds). */

Tff7b72val Te6edf3timestampTb4b4b4: Tffa657LongTb4b4b4,

Tb4b4b4)

T8b949e/** Response containing the current status of the Meshtastic mesh network. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364MeshStatusResponseTb4b4b4(

T8b949e/** The current radio connection state (e.g., CONNECTED, DISCONNECTED). */

Tf0883e@propertyTb4b4b4:Te6edf3AppFunctionStringValueConstraintTb4b4b4(Te6edf3enumValues Tff7b72= Tff7b72[Ta5d6ff"Ta5d6ffCONNECTEDTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffDISCONNECTEDTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffDEVICE_SLEEPTa5d6ff"Tff7b72]Tb4b4b4)

Tff7b72val Te6edf3connectionStateTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** The number of nodes currently online (heard within the last 2 hours). */

Tff7b72val Te6edf3onlineNodeCountTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** The total number of nodes known to the network. */

Tff7b72val Te6edf3totalNodeCountTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** The battery percentage of the connected Meshtastic device (1-100), or null if unavailable. */

Tff7b72val Te6edf3localBatteryLevelTb4b4b4: Tffa657Int?Tb4b4b4,

T8b949e/** The display name of the local node, or null if not set. */

Tff7b72val Te6edf3localNodeNameTb4b4b4: Tffa657String?Tb4b4b4,

Tb4b4b4)

T8b949e/** Information about a single mesh node. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364NodeInfoTb4b4b4(

T8b949e/** The unique node identifier in Meshtastic hex format (e.g., !abc12345). */

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** The human-readable name of the node. */

Tff7b72val Te6edf3nameTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** The node's battery percentage (0-100), or null if unavailable. */

Tff7b72val Te6edf3batteryLevelTb4b4b4: Tffa657Int?Tb4b4b4,

T8b949e/** The time this node was last heard from (epoch milliseconds). */

Tff7b72val Te6edf3lastHeardTb4b4b4: Tffa657LongTb4b4b4,

T8b949e/** Whether this node is currently considered online. */

Tff7b72val Te6edf3isOnlineTb4b4b4: Tffa657BooleanTb4b4b4,

Tb4b4b4)

T8b949e/** Response containing a list of nodes visible on the mesh network. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364GetNodeListResponseTb4b4b4(

T8b949e/** List of nodes sorted by most recently heard first. */

Tff7b72val Te6edf3nodesTb4b4b4: Te6edf3ListTff7b72<Te6edf3NodeInfoTff7b72>Tb4b4b4,

Tb4b4b4)

T8b949e/** Information about a single mesh channel. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364ChannelInfoTb4b4b4(

T8b949e/** The channel index (0-7). */

Tf0883e@propertyTb4b4b4:Te6edf3AppFunctionIntValueConstraintTb4b4b4(Te6edf3enumValues Tff7b72= Tff7b72[T79c0ff0Tb4b4b4, T79c0ff1Tb4b4b4, T79c0ff2Tb4b4b4, T79c0ff3Tb4b4b4, T79c0ff4Tb4b4b4, T79c0ff5Tb4b4b4, T79c0ff6Tb4b4b4, T79c0ff7Tff7b72]Tb4b4b4) Tff7b72val Te6edf3indexTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** The human-readable name of the channel. */

Tff7b72val Te6edf3nameTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Whether this is the primary/default channel. */

Tff7b72val Te6edf3isPrimaryTb4b4b4: Tffa657BooleanTb4b4b4,

T8b949e/** Whether uplink is enabled for this channel. */

Tff7b72val Te6edf3uplinkEnabledTb4b4b4: Tffa657BooleanTb4b4b4,

T8b949e/** Whether downlink is enabled for this channel. */

Tff7b72val Te6edf3downlinkEnabledTb4b4b4: Tffa657BooleanTb4b4b4,

Tb4b4b4)

T8b949e/** Response containing the list of available mesh channels. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364GetChannelInfoResponseTb4b4b4(

T8b949e/** List of all configured channels. */

Tff7b72val Te6edf3channelsTb4b4b4: Te6edf3ListTff7b72<Te6edf3ChannelInfoTff7b72>Tb4b4b4,

Tb4b4b4)

T8b949e/** Response containing the status of the local Meshtastic device. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364GetDeviceStatusResponseTb4b4b4(

T8b949e/** The hardware model of the device (e.g., "Meshtastic nRF52840"). */

Tff7b72val Te6edf3modelTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** The firmware version string. */

Tff7b72val Te6edf3firmwareVersionTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** The device battery percentage (0-100), or null if not battery-powered. */

Tff7b72val Te6edf3batteryLevelTb4b4b4: Tffa657Int?Tb4b4b4,

T8b949e/** The charging state (CHARGING, NOT_CHARGING, or UNKNOWN). */

Tf0883e@propertyTb4b4b4:Te6edf3AppFunctionStringValueConstraintTb4b4b4(Te6edf3enumValues Tff7b72= Tff7b72[Ta5d6ff"Ta5d6ffCHARGINGTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffNOT_CHARGINGTa5d6ff"Tb4b4b4, Ta5d6ff"Ta5d6ffUNKNOWNTa5d6ff"Tff7b72]Tb4b4b4)

Tff7b72val Te6edf3chargingStatusTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** The display name of the device, or null if not set. */

Tff7b72val Te6edf3deviceNameTb4b4b4: Tffa657String?Tb4b4b4,

T8b949e/** Whether the radio is currently active and connected. */

Tff7b72val Te6edf3isActiveTb4b4b4: Tffa657BooleanTb4b4b4,

Tb4b4b4)

T8b949e/** Response containing detailed telemetry for a specific mesh node. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364GetNodeDetailsResponseTb4b4b4(

T8b949e/** Node ID in hex format (e.g., "!abc12345"). */

Tff7b72val Te6edf3idTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** User ID string for this node. */

Tff7b72val Te6edf3userIdTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Display name of the node. */

Tff7b72val Te6edf3nameTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Battery percentage (0-100), or null if unavailable. */

Tff7b72val Te6edf3batteryLevelTb4b4b4: Tffa657Int?Tb4b4b4,

T8b949e/** Supply voltage in volts, or null if unavailable. */

Tff7b72val Te6edf3voltageTb4b4b4: Tffa657Float?Tb4b4b4,

T8b949e/** Hardware model string. */

Tff7b72val Te6edf3hardwareModelTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Firmware version string. */

Tff7b72val Te6edf3firmwareVersionTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Signal-to-noise ratio in dB of the strongest signal, or null if this node has no reading. */

Tff7b72val Te6edf3snrTb4b4b4: Tffa657Float?Tb4b4b4,

T8b949e/** Received signal strength indicator in dBm, or null if this node has no reading. */

Tff7b72val Te6edf3rssiTb4b4b4: Tffa657Int?Tb4b4b4,

T8b949e/** Number of hops away from local node (-1 if unknown). */

Tff7b72val Te6edf3hopsAwayTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** Channel index this node is on. */

Tff7b72val Te6edf3channelTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** Last heard timestamp (milliseconds since epoch). */

Tff7b72val Te6edf3lastHeardTb4b4b4: Tffa657LongTb4b4b4,

T8b949e/** User role or device type. */

Tff7b72val Te6edf3userRoleTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Whether the user is licensed. */

Tff7b72val Te6edf3isLicensedTb4b4b4: Tffa657BooleanTb4b4b4,

T8b949e/** Latitude in degrees, or null if unknown. */

Tff7b72val Te6edf3latitudeTb4b4b4: Tffa657Double?Tb4b4b4,

T8b949e/** Longitude in degrees, or null if unknown. */

Tff7b72val Te6edf3longitudeTb4b4b4: Tffa657Double?Tb4b4b4,

Tb4b4b4)

T8b949e/** Response containing aggregate mesh network metrics. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364GetMeshMetricsResponseTb4b4b4(

T8b949e/** Total number of known nodes. */

Tff7b72val Te6edf3totalNodeCountTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** Number of nodes currently online. */

Tff7b72val Te6edf3onlineNodeCountTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** Average battery level across mesh, or null if no data. */

Tff7b72val Te6edf3averageBatteryLevelTb4b4b4: Tffa657Int?Tb4b4b4,

T8b949e/** Estimated health score (0-100). */

Tff7b72val Te6edf3meshHealthScoreTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** Timestamp of most recent packet (ms since epoch). */

Tff7b72val Te6edf3mostRecentPacketTimeTb4b4b4: Tffa657LongTb4b4b4,

T8b949e/** Mesh uptime in seconds. */

Tff7b72val Te6edf3meshUptimeSecondsTb4b4b4: Tffa657LongTb4b4b4,

T8b949e/** Channel utilization percentage, or null if unavailable. */

Tff7b72val Te6edf3channelUtilizationPercentTb4b4b4: Tffa657Int?Tb4b4b4,

Tb4b4b4)

T8b949e/** Response containing recent messages from the mesh network. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364GetRecentMessagesResponseTb4b4b4(

T8b949e/** List of recent messages ordered by most recent first. */

Tff7b72val Te6edf3messagesTb4b4b4: Te6edf3ListTff7b72<Te6edf3MessageInfoTff7b72>Tb4b4b4,

Tb4b4b4)

T8b949e/** Information about a single mesh message. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364MessageInfoTb4b4b4(

T8b949e/** Display name of the message sender. */

Tff7b72val Te6edf3senderNameTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** The message text content. */

Tff7b72val Te6edf3textTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Name of the channel or contact the message belongs to. */

Tff7b72val Te6edf3contactNameTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Timestamp when the message was received (ms since epoch). */

Tff7b72val Te6edf3receivedTimeTb4b4b4: Tffa657LongTb4b4b4,

T8b949e/** True if this message was sent by the local user. */

Tff7b72val Te6edf3fromLocalTb4b4b4: Tffa657BooleanTb4b4b4,

T8b949e/** True if this message has been read by the user. */

Tff7b72val Te6edf3readTb4b4b4: Tffa657BooleanTb4b4b4,

Tb4b4b4)

T8b949e/** Response containing a summary of unread messages across all contacts. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364GetUnreadSummaryResponseTb4b4b4(

T8b949e/** Total number of unread messages across all non-muted contacts. */

Tff7b72val Te6edf3totalUnreadCountTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** Per-contact breakdown of unread messages, sorted by most recent. */

Tff7b72val Te6edf3contactsTb4b4b4: Te6edf3ListTff7b72<Te6edf3ContactUnreadInfoTff7b72>Tb4b4b4,

Tb4b4b4)

T8b949e/** Unread message details for a single contact or channel. */

Tf0883e@AppFunctionSerializableTb4b4b4(Te6edf3isDescribedByKDoc Tff7b72= Tff7b72trueTb4b4b4)

Tff7b72data Tff7b72class T56d364ContactUnreadInfoTb4b4b4(

T8b949e/** Display name of the contact or channel. */

Tff7b72val Te6edf3nameTb4b4b4: Tffa657StringTb4b4b4,

T8b949e/** Number of unread messages from this contact. */

Tff7b72val Te6edf3unreadCountTb4b4b4: Tffa657IntTb4b4b4,

T8b949e/** Preview text of the most recent message (up to 100 chars), or null if unavailable. */

Tff7b72val Te6edf3lastMessagePreviewTb4b4b4: Tffa657String?Tb4b4b4,

T8b949e/** Timestamp of the most recent message (ms since epoch), or null if unavailable. */

Tff7b72val Te6edf3lastMessageTimeTb4b4b4: Tffa657Long?Tb4b4b4,

Tb4b4b4)